CRM360° CustomerApi Documentation

Customer - Store

Manage the stores attached to contacts for the current user's allowed zones.

Required HTTP Headers

  • X-Crm360Api-Token
  • X-Crm360Api-CustomerName
  • X-Crm360Api-DatabaseAlias

Functions

Entity Properties

Name Type Is Mandatory
StoreId Int32
StoreIdentifier String
Name String
Address1 String
Address2 String
Address3 String
Address4 String
Address5 String
Address6 String
Address7 String
PostCode String
City String
State String
CountryId String
PhoneNumber String
FaxNumber String
EmailAddress String
StoreTypeId Int16
StoreStateId Int16
DeletionFlag Boolean
BrandId Int32
ZoneId Int32
FreeField1 String
FreeField2 String
FreeField3 String
FreeField4 String
FreeField5 String
FreeFieldDateTime1 DateTime
FreeFieldDateTime2 DateTime
FreeFieldDateTime3 DateTime
FreeFieldDateTime4 DateTime
FreeFieldDateTime5 DateTime
FreeFieldNumber1 Decimal
FreeFieldNumber2 Decimal
FreeFieldNumber3 Decimal
FreeFieldNumber4 Decimal
FreeFieldNumber5 Decimal
FreeFieldBoolean1 Boolean
FreeFieldBoolean2 Boolean
FreeFieldBoolean3 Boolean
FreeFieldBoolean4 Boolean
FreeFieldBoolean5 Boolean
SourceId Int16
PurchaseHeaders Collection of PurchaseHeader
Brand Brand
Zone Zone
Country Country
StoreType StoreType
StoreState StoreState
AttachedStores Collection of AttachedStore
LoyaltyCards Collection of LoyaltyCard
Source Source

Examples

Select all Stores

https://customerapi.fts-crm360.com/data/Stores()
HttpMethod : GET
Json Result :
[ { "StoreId" : "62", "StoreIdentifier" : "dRxhNBSUsd LujF5", "Name" : "PAk3i", "Address1" : "G tyB50 tFZ2t", "Address2" : "NzpI1", "Address3" : "zzR7dvV9s", "Address4" : "B45upHfO", "Address5" : "1dQFVrY", "Address6" : "ybWaAPtTIxTSj1SeCf", "Address7" : "9YESa4bcVhLlxXcLQ2l", "PostCode" : "qAV u581 LwB vZfsI", "City" : "hjxYw8Kh6FpAncnQ8B", "State" : "jf7lcJ", "CountryId" : "IwB87dH6CS3okBiY", "PhoneNumber" : "vUJIj", "FaxNumber" : "dbdnjal", "EmailAddress" : "UO zZe8JL4rZVYTbC G", "StoreTypeId" : "9", "StoreStateId" : "8", "DeletionFlag" : "True", "BrandId" : "99", "ZoneId" : "63", "FreeField1" : "jigd1ifcTj lO", "FreeField2" : "3DlIPbJ", "FreeField3" : "FHAkjTqHLOWN06bqU", "FreeField4" : "K7Az41z1N1", "FreeField5" : "vL scZb", "FreeFieldDateTime1" : "2003-04-16T00:00:00", "FreeFieldDateTime2" : "2023-12-01T00:00:00", "FreeFieldDateTime3" : "2000-10-25T00:00:00", "FreeFieldDateTime4" : "2017-11-18T00:00:00", "FreeFieldDateTime5" : "2000-04-22T00:00:00", "FreeFieldNumber1" : "4231396.989", "FreeFieldNumber2" : "3283227.718", "FreeFieldNumber3" : "8252825.131", "FreeFieldNumber4" : "4928476.853", "FreeFieldNumber5" : "3428928.223", "FreeFieldBoolean1" : "False", "FreeFieldBoolean2" : "False", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "True", "FreeFieldBoolean5" : "True", "SourceId" : "2" }, { "StoreId" : "69", "StoreIdentifier" : "MLdkrx", "Name" : "SC 0eh8KzliA", "Address1" : "QmPR26gF2MiPBh", "Address2" : "VyooYTmH2WrviF", "Address3" : "WuJBzk7Mt", "Address4" : "Qba0bkc W0A74oVo", "Address5" : "Y5LL9 j1zE t", "Address6" : "Yk64G", "Address7" : "LR wNvLPRZ0gsKFiRh", "PostCode" : "Sb1 ofcRUba", "City" : "cbM9J8bxvSb8", "State" : "Ri60TZV aVSwQ", "CountryId" : "c1y0Y0 Pt3kHjFfr", "PhoneNumber" : "ir6LuZmHmorBG", "FaxNumber" : "M4M 58bCHkB BPL OT", "EmailAddress" : "wvEUjucKtxLSNm Y", "StoreTypeId" : "3", "StoreStateId" : "4", "DeletionFlag" : "True", "BrandId" : "59", "ZoneId" : "73", "FreeField1" : "ejWI4W", "FreeField2" : "6x XSVJHjn", "FreeField3" : "cxtQ6R N", "FreeField4" : "28bHt", "FreeField5" : "pPg9", "FreeFieldDateTime1" : "2019-05-31T00:00:00", "FreeFieldDateTime2" : "1998-02-17T00:00:00", "FreeFieldDateTime3" : "2019-02-08T00:00:00", "FreeFieldDateTime4" : "2018-03-15T00:00:00", "FreeFieldDateTime5" : "2024-02-24T00:00:00", "FreeFieldNumber1" : "8993836.782", "FreeFieldNumber2" : "9426137.359", "FreeFieldNumber3" : "3363796.624", "FreeFieldNumber4" : "4993249.936", "FreeFieldNumber5" : "3736131.991", "FreeFieldBoolean1" : "False", "FreeFieldBoolean2" : "False", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "True", "FreeFieldBoolean5" : "False", "SourceId" : "5" }, ... ]

Select Store by Id

https://customerapi.fts-crm360.com/data/Stores(62)
HttpMethod : GET
Json Result :
{ "StoreId" : "27", "StoreIdentifier" : "k5pCgbx d7dtau", "Name" : "2pmBC", "Address1" : "a3tsHQhm", "Address2" : "mpEQXU", "Address3" : "PLzzDxE Kp vdJBcN I", "Address4" : "7WZKO", "Address5" : "XUznJWu4 a", "Address6" : "OJpySgc1", "Address7" : "I7jM21OSA3xnkr v", "PostCode" : "hfD jvmN9PeOo", "City" : "UbO vmvSHb3gpmpdOBs", "State" : "7yykM894mvDYC SIb", "CountryId" : "xM6jqN7mTwPL70 hopN", "PhoneNumber" : "n1rXYfc0TgBPBsMu", "FaxNumber" : "O49 Wk0f2bN veyxM", "EmailAddress" : "6gjKKwGSyu", "StoreTypeId" : "9", "StoreStateId" : "2", "DeletionFlag" : "True", "BrandId" : "64", "ZoneId" : "27", "FreeField1" : "vOxQQ02fDPAjBO", "FreeField2" : "WQNSCtN4CyG", "FreeField3" : "tMjiDDBhaEpq", "FreeField4" : "qGfFuwfgT3XBYXB", "FreeField5" : "3MduW", "FreeFieldDateTime1" : "2018-01-21T00:00:00", "FreeFieldDateTime2" : "2020-02-08T00:00:00", "FreeFieldDateTime3" : "2014-11-21T00:00:00", "FreeFieldDateTime4" : "2008-07-29T00:00:00", "FreeFieldDateTime5" : "2009-06-15T00:00:00", "FreeFieldNumber1" : "9294365.646", "FreeFieldNumber2" : "7831694.325", "FreeFieldNumber3" : "7715582.938", "FreeFieldNumber4" : "3863836.967", "FreeFieldNumber5" : "5894319.524", "FreeFieldBoolean1" : "True", "FreeFieldBoolean2" : "True", "FreeFieldBoolean3" : "False", "FreeFieldBoolean4" : "True", "FreeFieldBoolean5" : "False", "SourceId" : "3" }

Create a Store

https://customerapi.fts-crm360.com/data/Stores()
HttpMethod : POST
Json Post :
{
"StoreIdentifier" : "1YamRf",
"Name" : "3KDOSZesb",
"Address1" : "skMd uz7ftWqagHJCO",
"Address2" : "3feEa4zM0",
"Address3" : "3 B76jlNYZsyU ngeot",
"Address4" : "OacHGXN",
"Address5" : "xjKg98m4Tue8",
"Address6" : "7q0mFLec4 Ke",
"Address7" : "vbX5 jWFazNK WY",
"PostCode" : "NwIwoRwmfALtB3J",
"City" : "BSNJg",
"State" : "46l f2maQ",
"CountryId" : "uqpAuA",
"PhoneNumber" : "rv zYnDioNIg",
"FaxNumber" : "OM 1NJN",
"EmailAddress" : "4 DwWnTMf9TQvcx9",
"StoreTypeId" : "1",
"StoreStateId" : "6",
"DeletionFlag" : "True",
"BrandId" : "36",
"ZoneId" : "95",
"FreeField1" : "ZSur2h1y",
"FreeField2" : "jzsyvVBA vWIP0PYw",
"FreeField3" : "0vpK1zrlxAp",
"FreeField4" : "xVsJucCqAnCh9mlD",
"FreeField5" : "bdSGG C",
"FreeFieldDateTime1" : "1999-07-21T00:00:00",
"FreeFieldDateTime2" : "2006-06-23T00:00:00",
"FreeFieldDateTime3" : "2023-03-04T00:00:00",
"FreeFieldDateTime4" : "2020-12-22T00:00:00",
"FreeFieldDateTime5" : "1998-05-24T00:00:00",
"FreeFieldNumber1" : "2614391.411",
"FreeFieldNumber2" : "8414272.232",
"FreeFieldNumber3" : "6535467.461",
"FreeFieldNumber4" : "4525811.276",
"FreeFieldNumber5" : "6614791.784",
"FreeFieldBoolean1" : "True",
"FreeFieldBoolean2" : "False",
"FreeFieldBoolean3" : "True",
"FreeFieldBoolean4" : "False",
"FreeFieldBoolean5" : "False",
"SourceId" : "7"
}
            
Informations :
- Non mandatory fields are optional for Json Post

Delete a Store

https://customerapi.fts-crm360.com/data/Stores(62)
HttpMethod : DELETE